home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 4 / Mac Giga-ROM 4.0 - 1993.toast / FILES / COP / A-M / Extra Translators 4 SD.sea / Translator Documentation / About TAR Translator < prev   
Text File  |  1991-01-24  |  12KB  |  361 lines
  1. TAR Translator for StuffIt Deluxe
  2.  
  3. Version 1.0 of 91.01.24.
  4.  
  5. Written by Raymond Lau
  6.  
  7. Copyright (C) 1991, Raymond Lau.  All Rights Reserved.
  8.  
  9.  
  10. This software is being licensed to you free of cost.
  11.  
  12. Please see Terms of usage and distribution at the end
  13. of this document for information regarding your right
  14. to use and distribute this software.
  15.  
  16.  
  17.  
  18. Introduction:
  19.  
  20. The tar Translator is an external translator for use
  21. with StuffIt Deluxe, available from Aladdin Systems, Inc.,
  22. Deer Part Center, #23A-171, Aptos, CA 95003-4723.
  23. This translator provides compatibility with the UNIX tape
  24. archiver, tar.
  25.  
  26. Many files available on UNIX systems are archived with tar.
  27. This translator allows you to decode these archives.  It also
  28. allows you to create archives which can be decoded by tar
  29. on these systems.
  30.  
  31. Tar file names generally have a ".tar" suffix.
  32.  
  33.  
  34.  
  35. Installation:
  36.  
  37. The rest of this documentation assumes that you have properly
  38. installed StuffIt Deluxe and are familiar with the operation
  39. of StuffIt Deluxe.
  40.  
  41. To install this translator, placed it in the Translators
  42. folder in the System folder of your startup drive.  Then
  43. launch (or quit and relaunch, as appropriate) StuffIt Deluxe.
  44.  
  45. If you are in Standard menu mode, you must switch to Expert
  46. menu mode to use this translator.
  47.  
  48.  
  49.  
  50. Operation:
  51.  
  52. After installation, you should have a new choice under the
  53. Other menu with the name "tar."  This item has
  54. 2 subitems.  The subitems are Create... and List and
  55. Extract...
  56.  
  57. To create a tar archive for transmission, select the Create
  58. menu choice.  You will be presented a dialog similar to
  59. the Multiple Stuff dialog in StuffIt Deluxe.  Just select
  60. the files and folders to be archived.  For each item, you
  61. my select to have carriage returns converted to linefeeds.
  62. (Text files on the Macintosh use carriage returns to
  63. terminate lines.  On UNIX systems, linefeeds are normally
  64. used to terminate lines.)
  65.  
  66. ----------------
  67. Technical note:
  68.  
  69. Each file/folder you select will be placed in the archive
  70. as if there item were in the current directory.  In other
  71. words, if you select the following files:
  72.  
  73. file1
  74. file2
  75.  
  76. and the following folders:
  77.  
  78. folder1
  79. folder2
  80.  
  81. when you use tar on UNIX to extract these items, all 4
  82. items will be extracted to the directory you specify.
  83. (The hierarchy of the folders will be maintained.)
  84.  
  85. Note that some filename translation occurs to make
  86. Macintosh file names compatible with UNIX.
  87. However, no filename truncation occurs as most UNIX
  88. systems allow up to the Mac's limit of 31 chars/file name.
  89. A few systems do not, so beware!
  90.  
  91. Also, only the data fork of a file is archive.  The
  92. modification date/time of an archived file/folder will be
  93. set to the modification date/time on the original file,
  94. however, it will NOT be translated into UCT.  The result
  95. is that when the files are extracted on a UNIX system,
  96. the times may be a few hours off.  Relying on the Map
  97. cdev setting on the Macintosh is relying on something
  98. that many users don't even know about!
  99. ------------------
  100.  
  101. After selecting the files/folders, hit Archive All Items.
  102. You will be prompted to save the archive.
  103.  
  104. When you transfer a tar archive from the Macintosh to
  105. another system, you should normally have the MacBinary
  106. option turned off in your file transfer program.
  107. Otherwise, the MacBinary header added by your file
  108. transfer program will prevent the archive from being
  109. recognized as a legitimate .tar archive.
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116. To get a listing of a tar archive or to extract files
  117. from one, select List and Extract.  Then find the tar
  118. archive of interest.
  119.  
  120. After opening it, its directory will be read and
  121. displayed on the screen.
  122.  
  123. If you just want to view the listing, hit Done when
  124. you are done.  In the listing, the first column
  125. tells you whether something is a file, directory or
  126. a special file (block, link, etc.)  The symbol used
  127. is the same as that used by the UNIX ls -l command.
  128.  
  129. To extract files, select the files to extract, using
  130. the shift and command keys to extend your selection if
  131. needed.
  132.  
  133. Then hit Extract.
  134.  
  135. If you want linefeeds converted to carriage returns
  136. (On UNIX systems, linefeeds are used to terminate
  137. lines but on the Macintosh, carriage returns are used),
  138. check that check box before hitting Extract.
  139.  
  140. You will be prompted as to where the files/folders
  141. should be extracted to.
  142.  
  143. If there are any naming conflicts, you will be prompted
  144. whether to skip or replace (with the option of replacing
  145. all future conflicting existing files) existing files.
  146. You may also cancel the process.  Folders will never be
  147. replaced.  This is in keeping with the UNIX tar convention.
  148. Files will be placed into existing folders if folders
  149. have the same name.
  150.  
  151.  
  152. ---------------
  153. Technical Note:
  154.  
  155. Be careful when extracting "dot files," files whose
  156. name starts with a period.  While the translator
  157. handles these files properly, other applications may
  158. not.  The reason is because the names may be mistaken
  159. for the names of drivers on the Mac.  For example,
  160. using DiskTop to copy dotfiles with certain names
  161. results in a machine hang.
  162.  
  163. Also, because UNIX file names are case sensitive,
  164. when a file already exists on your Mac with the same
  165. name but different case in one or more characters,
  166. the translator will add /1, /2, etc. to the name.
  167. ---------------
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178. ----------------
  179. BUG NOTE:
  180.  
  181. There is a bug in StuffIt Deluxe 2.0.1 and earlier as
  182. well as StuffIt Classic 1.6.1 and earlier that prevents
  183. the status window from changing correctly to the folder
  184. version when a translator processes a folder.  This
  185. bug also causes "flashing" of the window after each item.
  186. These are visual defects only and this bug will be fixed
  187. in a future revision.
  188. ----------------
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. Appendix A: Terms of usage and distribution:
  197.  
  198. Although copyrighted, this software is being licensed 
  199. to you for your use free of charge.  However, ownership
  200. of and interest in this software shall remain with the
  201. author.  Use and distribution of this software is
  202. governed by the following terms in an effort to
  203. reasonably insure that this software will remain
  204. freely available and that no one other than the author
  205. will derive a commercial benefit from distributing
  206. this software.
  207.  
  208.  
  209. LICENSE AGREEMENT
  210.  
  211.  
  212. "You," "your," and the "user" refers to any person or
  213. entity which acquires or uses this software.
  214.  
  215. "Software" refers to any computer programs identified
  216. at the start of this documentation file, together with
  217. all codes, techniques, software tools, formats, designs,
  218. concepts, methods, ideas, and documentation assoicated
  219. with the computer program(s).  The term also includes
  220. all copies of any part of the software and documentation.
  221.  
  222. "Author" refers to the author of this software, Raymond
  223. Lau.
  224.  
  225.  
  226. This software is owned by the author and contains
  227. valuable and proprietary information of the author's.
  228. If you violate any part of this agreement, your right
  229. to use this software terminates automatically.  In the
  230. event of termination of this agreement, you must destroy
  231. all copies of this software and derivatives of this
  232. software in your possession and cease distributing the
  233. same.
  234.  
  235. This software is being licensed to you as provided by
  236. the terms of this agreement.
  237.  
  238. You may:
  239.    1. Use this software on as many computers
  240.       as you want at any given time.
  241.    2. Make as many backup copies of this software as
  242.       you want.
  243.    3. Alter the software in any manner you see fit
  244.       FOR YOUR OWN PERSONAL USE.  Such altered versions
  245.       should not be distributed.  The creation of
  246.       such derivatives shall not diminish the author's
  247.       title to this software.
  248.    4. Terminate this agreement at any time by destroying
  249.       all copies of this software and derivatives of
  250.       this software and cease distributing the same.
  251.  
  252. You may not:
  253.    1. Create any derivative works from this software
  254.       for distribution.
  255.    2. Reverse engineer, disassemble, decompile, or
  256.       otherwise attempt to discover the source code to
  257.       this software.
  258.    3. Use this software in any manner as to discover
  259.       proprietary information relating to the Translator
  260.       interface in StuffIt Deluxe.
  261.  
  262.  
  263. You may distribute this software provided that:
  264.    1. This software is distributed free of any charges
  265.       except as provided for under 1a.  This software may
  266.       not be sub-licensed, sold, lent, rented, or leased
  267.       except as provided for under 1a.
  268.           1a. You may charge a nominal fee to cover
  269.               duplication, shipping and/or handling costs
  270.               of distributing this software provided that
  271.               the pro-rata fee (ex: the fee of ordering a
  272.               disk/CD/tape/etc divided by the number of 
  273.               programs on it) does not exceed US $1.  You
  274.               may include this software in any compilation
  275.               even if you sell the compilation for a
  276.               profit provided that the pro-rata fee defined
  277.               above does not exceed US $1 for this software.
  278.  
  279.               You may also charge your usual timesharing,
  280.               network usage and/or membership fee if you
  281.               distribute this software electronically.
  282.  
  283.               While you may claim a compilation copyright
  284.               on any compilations which include this
  285.               software, interest in and ownership of this
  286.               software shall remain with the author.
  287.             
  288.    2. You include this documentation file with the
  289.       distribution.
  290.    3. You do not modify either this documentation file
  291.       or the software itself.
  292.    4. You do not use the name of this software or
  293.       of the author or the fact that you provide this
  294.       software in any promotional material relating
  295.       to your distribution of this software.  However, you
  296.       may include such information in a catalog listing of
  297.       your offerings.
  298.    5. You may not transfer this software in a manner as
  299.       to violate any regulations relating to the transfer
  300.       of software, including the US Export Administration
  301.       Act.
  302.  
  303. Disclaimer of warranty:
  304.  
  305. In using this software, you understand and agree that this
  306. software is provided "as is" without warranty of any kind.
  307. The entire risk as to the results and performance of using
  308. this software lies entirely with you, the user.  The author
  309. does not make any warranties, either expressed or implied,
  310. including but not limited to implied warranties of
  311. merchantability and fitness for a particular purpose, with
  312. respect to this software.
  313.  
  314. In no event shall the author be liable for any consequential,
  315. incidental, or special damages whatsoever (including without
  316. limitation damages for loss of critical data, loss of profits,
  317. interruption of business, and the like) arising out of the
  318. use or inability to use this software.  Because some states
  319. do not allow the exclusion or limitation of liability for
  320. consequential or incidental damages, the above limitations
  321. may not apply to you.
  322.  
  323. Although the author would appreciate any feedback and bug
  324. reports, the author shall not be responsible for correcting
  325. any problems which you discover or otherwise help you
  326. maintain and use this software.  Furthermore, the author
  327. may at any time replace, modify, alter, improve, enhance
  328. or change this software.
  329.  
  330.  
  331. Complete agreement:
  332.  
  333. This agreement constitues the entire agreement and supersedes
  334. any prior agreements between you and the author concerning
  335. this software.  This agreement cannot be amended, modified,
  336. or waived except in writing.
  337.  
  338. General:
  339.  
  340. If any provision of this agreement is found to be
  341. unenforcible, it shall be deemed severed from the remainder
  342. of this agreement.
  343.  
  344. This agreement shall be construed in accordance with the laws
  345. of the State of New York.  Any arbitration or litigation
  346. relating to this agreement shall take place in the State of
  347. New York.
  348.  
  349.  
  350.  
  351. U.S. GOVERNMENT RESTRICTED RIGHTS
  352.  
  353. This Software is provided with RESTRICTED RIGHTS.  Use,
  354. duplication, or disclosure by the government is subject to
  355. restrictions set forth in subparagraph (c)(1)(ii) of the
  356. Rights in Technical Data and Computer Software clause at
  357. 48 CFR 252.227-7013, or in subparagraphs (a) through (d) of
  358. the Commercial Computer Software Restricted Rights clause at
  359. 48 CFR 52.227-19, as applicable.  The contractor/manufacturer
  360. is Raymond Lau, 100-04 70 Ave., Forest Hills, NY 11375-5133.
  361.